<!DOCTYPE html>
<html xmlns:t="http://twistedmatrix.com/ns/twisted.web.template/0.1">
  <meta name="pydoctor-template-version" content="2" />

  <t:transparent t:render="head">Head</t:transparent>

  <body>

    <div t:render="header" />

    <nav class="navbar navbar-default mainnavbar">
      <t:transparent t:render="nav" />
    
        <!-- Side navigation -->
      <div class="sidebarcontainer" t:render="sidebarcontainer">
        <t:slot name="sidebar">SideBar contents </t:slot>
        <!-- No sidebar toggle for read the docs theme, the sidebar is always
          visible when the screen is width enough.
        -->
      </div>

    </nav>
    
    <div class="container-fluid">

      <div id="main">
        <t:attr name="class" t:render="maindivclass" />

        <div t:render="subheader" />

        <div id="search-results-container" style="display: none;">
        
          <div id="search-buttons">
            <span class="label label-default" id="search-docstrings-button">
            <label class="checkbox-inline">
              <input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
                search in docstrings
              </input>
            </label>
            </span>
            
          </div>
          
          <noscript>
              <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
          </noscript>
  
          <div class="hint" id="search-help-box">
            <p class="rst-last">
        
              Search bar offers the following options:
              <ul>   
                  <li>
                    <strong>Term presence.</strong> The below example searches for documents that 
                      must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
                  </li> 
  
                  <li>
                    <strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
                  </li> 
  
                  <li>
                    <strong>Search in specific fields.</strong> The following search matches all objects 
                    in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
  
                    <p>
                      Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
                      Last two fields are only applicable if "search in docstrings" is enabled.
                    </p>
                  </li>
  
                  <li>
                    <strong>Fuzzy matches.</strong> The following search matches all documents 
                    that have a word within 1 edit distance of “foo”: <code>foo~1</code>
                  </li>
              </ul>
  
            </p>
          </div>
  
          <div id="search-status"> </div>
  
          <div class="warning" id="search-warn-box" style="display: none;">
            <p class="rst-last"><span id="search-warn"></span></p>
          </div>
  
          <table id="search-results">
            <!-- Filled dynamically by JS -->
          </table>
          
          <div style="margin-top: 8px;">
            <p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
          </div>
        </div>

        <div class="page-header">
          <t:slot name="heading"><h1>Heading</h1></t:slot>
          <div id="showPrivate">
            <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
          </div>
        </div>

        <div class="categoryHeader">
          <t:slot name="category">something documentation</t:slot>
        </div>

        <div class="extrasDocstring">
          <t:slot name="extras">
            Inheritance info.
          </t:slot>
          <p><a t:render="inhierarchy">View In Hierarchy</a></p>
        </div>

        <div class="moduleDocstring">
          <t:slot name="docstring">
            A docstring.
          </t:slot>
        </div>

        <div id="splitTables">
          <t:slot name="mainTable" />
          <t:transparent t:render="baseTables">
            <p class="inheritedFrom">
              Inherited from <t:slot name="baseName" />:
            </p>
            <t:slot name="baseTable" />
            </t:transparent>

            <t:slot name="packageInitTable"> </t:slot>
        </div>

        <div id="childList">
          <t:slot name="childlist"> </t:slot>
        </div>
      
      </div>
    </div>

    <footer class="container-fluid" t:render="footer" />
  
    <script src="pydoctor.js" type='text/javascript'></script>

  </body>
</html>
